Add Recipients
AutomatR.DocuSign.Activities.AddRecipients
The "Add Recipients" activity in AutomatR is part of the DocuSign activities package, designed to add recipients to a specified envelope in DocuSign. This activity streamlines the process of managing recipients for document signing, enhancing the efficiency of automation workflows.
Properties
Name | Description |
---|---|
Input | |
Envelope ID | Enter the envelope ID for the envelope to which recipients will be added. String variables containing the envelope ID. |
Recipient Details | Enter a list of Signer objects representing the recipients of the envelope. Each Signer object should contain properties such as RecipientId, Email, Name, RoleName, etc. |
Resend Envelope | If checked, it resends the envelope to all the recipients (existing also). Boolean variables containing the resend option. |
Misc | |
Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
Optional | |
Delay | Specifies the amount of time (in seconds) to wait before executing the "Add Recipients" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
Output | |
Response | Returns the updated recipients with data type RecipientsUpdateSummary . |
Invalid Emails | Returns the invalid emails with data type List<string> . |
How to use:
- Drag and drop the "Add Recipients" activity onto the workflow.
- Configure the properties by providing the envelope ID, recipient details, and optional settings.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to add recipients to the specified envelope in DocuSign.
Example: Consider an example where the "Add Recipients" activity is used to add signers to an existing envelope in DocuSign:
Add Recipients:
Display Name: "Add Signers to Envelope"
Envelope ID: "abc123def456"
Recipient Details:
- RecipientId: "1"
Email: "recipient1@example.com"
Name: "Recipient One"
RoleName: "Signer"
- RecipientId: "2"
Email: "recipient2@example.com"
Name: "Recipient Two"
RoleName: "Approver"
Resend Envelope: false
In this example, the activity adds two recipients with their email addresses, names, and role names to the envelope with the ID "abc123def456." The envelope is not resent to the recipients since the "Resend Envelope" option is set to false. The response from the activity, including any updated recipient information, is stored for further handling in the workflow.